redmond-ux

(0 reviews)

TMF638 - serviceInventory

1. GET /service

This operation retrieves the services with products for the provided accountNumber.

URL

https://[host]:[port]/redmond-ux/v1/{businessId}/service

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	Y

name	value	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y

Query Params

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)
relatedEntity.id	string	unique identifier of the account. (BillingAccountID)	Y(LC)
state	string	state of the service	N(LC)
serviceType	string	Type of the service	N(LC)

Data Model

Response Data Model

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)
id	string	Unique identifier of the service / MSISDN / serviceNumber	Y(LC)
href	string	reference link of the service	Y(LC)
state	string	state of the service	Y(LC)
serviceType	string	Business type of the service	Y(LC)
supportingService[]	Object Array	A list of supporting services	Y(LC)
supportingService[].isServiceEnabled	boolean	If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed	Y(LC)
supportingService[].'@type'	string	When sub-classing, this defines the sub-class Extensible name	Y(LC)
serviceCharacteristic[]	Object Array	A list of characteristics that characterize this service	Y(LC)
serviceCharacteristic[].name	string	Name of the characteristic	Y(LC)
serviceCharacteristic[].valueType	string	identifier of the characteristic	Y(LC)
serviceCharacteristic[].value	object	Value of the characteristic	Y(LC)
relatedResource[]	Object Array	A related resource defines resource or role linked to a specific entity.	Y(LC)
relatedResource[].id	string	unique identifier	Y(LC)
relatedResource[].'@type'	string	When sub-classing, this defines the sub-class Extensible name	Y(LC)
serviceOrderItem[]	Object Array	A list of service order items related to this service	Y(LC)
serviceOrderItem[].serviceOrderId	string	Unique identifier of a related entity.	Y(LC
serviceOrderItem[].'@referredType'	string	The actual type of the target instance when needed for disambiguation.	N(LC)

supportingService subResource - dataModel

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)	examples
isServiceEnabled	string	If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed	Y(LC)	{"isServiceEnabled": false, "@type": "exDirectory" }
@type	string	When sub-classing, this defines the sub-class Extensible name	Y(LC)	{"isServiceEnabled": false, "@type": "exDirectory" }

serviceCharacteristic subResource - dataModel

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)	example
name	string	Name of the characteristic	Y(LC)	{"name": "prepaidInd","valueType": "boolean", "value": false}
valueType	string	identifier of the characteristic	Y(LC)	{"name": "prepaidInd","valueType": "boolean", "value": false}
value	boolean	Value of the characteristic	Y(LC)	{"name": "prepaidInd","valueType": "boolean", "value": false}

relatedResource subResource - dataModel

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)	example
id	string	unique identifier	Y(LC)	{"id": "355307980000", "@type": "accountNo" }
@type	string	When sub-classing, this defines the sub-class Extensible name	Y(LC)	{"id": "91722233", "@type": "UniqueId"}

serviceOrderItem subResource - dataModel

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)	example
serviceOrderId	string	identifier of the serviceOrder	Y(LC)	{"serviceOrderId": "7143", "@referredType": "Home Phone Starter Lite" }
@referredType	string	The actual type of the target instance when needed for disambiguation.	N(LC)	{"serviceOrderId": "7143", "@referredType": "Home Phone Starter Lite"}

Key considerations

Please refer the following link for sample responses REDMOND UX - GET service

Key considerations for LC (flow markets)

This is implemented for FIXED, POSTPAID and PREPAID lines.
This is implemented for LC markets (Liberate and Cerillion).
The service details are fetched from Liberate and Cerillion BSS based on the accountNumber.
To fetch only active services, the 'state' queryParam should be sent as "Active".
If the value of queryParam 'state' is not sent as Active, then services of all states are provided.
If the value of queryParam 'serviceType' is sent, then services of that particular serviceType are provided.

Possible states of liberate services

      A- Reserved
      B- Inactive
      C- Inactive
      D- Inactive
      R- Inactive
      S- Inactive
      T- Inactive
      X- Inactive
      W- Active
      Z- Terminated

Possible states of cerillion services

     CA- Terminated
     CU- Active
     FA- Reserved
     RE- Inactive
     RP- Inactive
     TA- Inactive
     TP- Inactive
     TR- Inactive

Possible values of liberate serviceTypes

    AA - Advertising Agency
    AD - Auto Dialling Device
    AX - AUDIOTEXT NUMBERS
    C4 - Call 400 Service
    C8 - 800 Service
    CB - Conference Bridge
    CC - Calling Card
    CD - Cellular Dealer
    CE - Mobile
    DA - Directory Advertising
    DD - Dealer Service
    DN - Dealer Service
    DS - Broadband
    DW - Digital WWL
    FP - Dummy FP service type
    GU - GPRS Service
    HD - Home Direct
    HG - Homefone-To-Go
    ID - IDAS
    IN - Internet Service
    JO - JOB ORDER
    JS - Interconnect Joining Service
    LC - Leased Circuit
    LL - Leased Line Service
    LM - eLearning
    MD - MONITORING DEVICE
    ML - MPLS Service
    MT - Metro Service
    P9 - 900 Calls
    RP - Mobile Reward Points
    SU - Sundry
    TG - Telegram
    TP - Landline
    TX - Telex
    UM - Urban Man Channel
    VI - Voice Over IP
    VS - VSAT
    VT - VSAT Service
    WM - Wireless ADSL/Wi-Max
    WS - Wireless ADSL
    XX - DUMMY AGENCY CARDS
    FX - Fax
    LP - C&W Conferencing on Demand
    S8 - SMS Service
    BU - Bundled Services
    CZ - CloudBlue
    FD - BLUU Streaming App
    VP - Private Voice Mail
    TI - TV
    G8 - Toll Free Data
    MV - Personal Voice Mail

Possible values of cerillion serviceTypes

    AV - Analog Video,
    CG - CUG Owner,
    CL - Cloud,
    DA - Data,
    DS - DSL,
    DV - Digital Video,
    ER - Equipment Rental,
    GM - Mobile,
    LM - Liberate Mobile,
    TP - Voice,
    XX - General,
    3P - Other Suppliers Products,
    BC - Business Consultant